import dayjs from 'dayjs'

/**
 * 获取当前日期字符串
 *
 * @param format - 日期格式字符串，默认为 'YYYY-MM-DD'，支持 dayjs 格式化规则
 * @returns 当前日期的格式化字符串
 *
 * @throws 当 `format` 不是字符串时抛出错误
 *
 * @example
 * ```ts
 * getToday()           // '2025-06-26'
 * getToday('YYYY/MM/DD') // '2025/06/26'
 * ```
 */
export function getToday(format: string = 'YYYY-MM-DD'): string {
  if (typeof format !== 'string') {
    throw new Error('[getToday] 参数 format 必须为字符串')
  }
  return dayjs().format(format)
}

export default getToday
